Prebuild script #71
Merged
Prebuild script #71
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
to mirror the configuration in our development environments
jordanstephens
force-pushed
the
prebuild
branch
4 times, most recently
from
06727e8
to
b4ad0c1
Compare
github actions prevents cloning a repo outside of the current working directory: actions/checkout#197
jordanstephens
force-pushed
the
prebuild
branch
from
b4ad0c1
to
5aeb649
Compare
raphaeltm
reviewed
Aug 14, 2024
|
@jordanstephens LGTM, though I have this one question: #71 (comment) If we can just make the CI directory structure consistent with local dev, I think that would be nicer, but I'm guessing it's just not possible in GitHub Actions? |
raphaeltm
approved these changes
Aug 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes two changes to make it more ergonomic to test doc deployment locally.
npm run prebuildscript to handle the following:a. navigating to the cli repo and running
gendocsb. running
prep-cli-docsto prepare frontmatter for each pagec. running
prep-samplesto build a page for each samplesamplesanddefanginto sibling directories to more closely mirror our local development environments so we could more easilycd defang-docs && npm run buildlocally, but i ran into Unable to clone outside of GITHUB_WORKSPACE directory actions/checkout#197. To try to preserve my intended user experience, I hacked around this by adding some complexity to theprebuild.shscript which checks for the presence of sibling directories first, then falls back to child directories.The
prebuildscript will automatically be run whennpm run buildis executed.